Delegated Authentication w/ SAML2

In the event that CAS is configured to delegate authentication to an external identity provider, the service provider (CAS) metadata as well as the identity provider metadata automatically become available at the following endpoints:

Endpoint Description
/sp/metadata Displays the service provider (CAS) metadata. Works well if there is only one SAML2 IdP is defined.
/sp/idp/metadata Displays the identity provider metadata. Works well if there is only one SAML2 IdP is defined. Accepts a force=true parameter to reload the identity provider’s metadata.
/sp/{clientName}/metadata Displays the service provider metadata for the requested client name.
/sp/{clientName}/idp/metadata Displays the identity provider metadata for the requested client name. Accepts a force=true parameter to reload the identity provider’s metadata

Note that you can use more than one external identity provider with CAS, where each integration may be done with a different set of metadata and keys for CAS acting as the service provider. Each integration (referred to as a client, since CAS itself becomes a client of the identity provider) may be given a name optionally.

Remember that the service provider (CAS) metadata is automatically generated once you access the above endpoints or view the CAS login screen. This is required because today, generating the metadata requires access to the HTTP request/response. In the event that metadata cannot be resolved, a status code of 406 - Not Acceptable is returned.

The following settings and properties are available from the CAS configuration catalog:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.authn.pac4j.saml[0].keystore-password=

    • The password to use when generating the SP/CAS keystore.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].keystore-path=/tmp/samlSpKeystore18323392581383948561.jks

    • Location of the keystore to use and generate the SP/CAS keystore.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].private-key-password=

    • The password to use when generating the private key for the SP/CAS keystore.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].service-provider-entity-id=https://apereo.org/cas/samlsp

    • The entity id of the SP/CAS that is used in the SP metadata generation process.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

  • cas.authn.pac4j.saml=

    • Settings that deal with having SAML2 IdPs as an external delegated-to authentication provider.

    org.apereo.cas.configuration.model.support.pac4j.Pac4jDelegatedAuthenticationProperties.
  • cas.authn.pac4j.saml[0].accepted-skew=PT300S

    • Maximum skew in seconds between SP and IDP clocks. This skew is added onto the NotOnOrAfter field in seconds for the SAML response validation.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].all-signature-validation-disabled=

    • Whether the signature validation should be disabled. Never set this property to true in production.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].assertion-consumer-service-index=-1

    • Allows the SAML client to select a specific ACS url from the metadata, if defined. A negative value de-activates the selection process and is the default.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].attribute-consuming-service-index=

    • AttributeConsumingServiceIndex attribute of AuthnRequest element. The given index points out a specific AttributeConsumingService structure, declared into the Service Provider (SP)'s metadata, to be used to specify all the attributes that the Service Provider is asking to be released within the authentication assertion returned by the Identity Provider (IdP). This attribute won't be sent with the request unless a positive value (including 0) is defined.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].authn-context-class-ref=

    • Requested authentication context class in authn requests.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].authn-context-comparison-type=exact

    • Specifies the comparison rule that should be used to evaluate the specified authentication methods. For example, if exact is specified, the authentication method used must match one of the authentication methods specified by the AuthnContextClassRef elements. AuthContextClassRef element require comparison rule to be used to evaluate the specified authentication methods. If not explicitly specified "exact" rule will be used by default. Other acceptable values are minimum, maximum, better.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].auto-redirect-type=NONE

    • Auto-redirect to this client.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].blocked-signature-signing-algorithms=

    • Collection of signing signature blocked algorithms, if any, to override the global defaults.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].callback-url=

    • Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done. This may be used at the discretion of the client and its type to build service parameters, redirect URIs, etc. If none is specified, the CAS server's login endpoint will be used as the basis of the final callback url.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].callback-url-type=QUERY_PARAMETER

    • Determine how the callback url should be resolved. Default is CallbackUrlTypes#QUERY_PARAMETER. Available values are as follows:

    • PATH_PARAMETER: Path parameter callback url. The client name is added to the path of the callback URL.
    • QUERY_PARAMETER: Query parameter callback url. The client name is added to the path of a query parameter.
    • NONE: No callback url. No name is added to the callback URL to be able to distinguish the client.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].certificate-expiration-days=7300

    • Define the validity period for the certificate in number of days. The end-date of the certificate is controlled by this setting, when defined as a value greater than zero.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].certificate-name-to-append=

    • A name to append to signing certificates generated. The named part appended can be useful to identify for which clientName it was generated If no name is provided the default certificate name will be used.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].certificate-signature-alg=SHA1WithRSA

    • Certificate signature algorithm to use when generating the certificate.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].client-name=

    • Name of the client mostly for UI purposes and uniqueness. This name, with 'non-word' characters converted to '-' (e.g. "This Org (New)" becomes "This-Org--New-") is added to the "class" attribute of the redirect link on the login page, to allow for custom styling of individual IdPs (e.g. for an organization logo).

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].css-class=

    • CSS class that should be assigned to this client.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].destination-binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect

    • The destination binding to use when creating authentication requests.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].display-name=

    • Indicate the title or display name of the client for decoration and client presentation purposes. If left blank, the client original name would be used by default.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].enabled=true

    • Whether the client/external identity provider should be considered active and enabled for integration purposes.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].force-auth=

    • Whether authentication requests should be tagged as forced auth.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].force-keystore-generation=

    • Force generation of the keystore.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].logout-request-binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect

    • The destination binding to use when creating logout requests.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].logout-response-binding-type=

    • Control the logout response binding type during logout operations as invoked by an external IdP and in response to logout requests.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].mapped-attributes=

    • Describes the map of attributes that are to be fetched from the credential (map keys) and then transformed/renamed using map values before they are put into a profile. An example might be to fetch givenName from credential and rename it to urn:oid:2.5.4.42 or vice versa. Note that this setting only applies to attribute names, and not friendly-names. List arbitrary mappings of claims. Uses a "directed list" where the allowed syntax would be givenName->urn:oid:2.5.4.42.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].maximum-authentication-lifetime=PT3600S

    • Once you have an authenticated session on the identity provider, usually it won't prompt you again to enter your credentials and it will automatically generate a new assertion for you. By default, the SAML client will accept assertions based on a previous authentication for one hour. You can adjust this behavior by modifying this setting. The unit of time here is seconds.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].message-store-factory=org.pac4j.saml.store.EmptyStoreFactory

    • Factory implementing this interface provides services for storing and retrieval of SAML messages for e.g. verification of retrieved responses. The default factory is an always empty store. You may choose org.pac4j.saml.store.HttpSessionStore instead which allows SAML messages to be stored in a distributed session store specially required for high availability deployments and validation operations.

    Available options are:
    • EMPTY: Uses the EmptyStoreFactory
    • SESSION: Uses the HttpSessionStore
    • Fully-qualified class name of the message store implementation.

    Also note that the message store implementation can be supplied and configured at runtime as a Spring @Bean with the type SAMLMessageStoreFactory which, if found in the available application context, will override all other options.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].name-id-attribute=

    • The attribute name that should be used and extracted from the SAML2 response to identify and build a NameID value, when the response is processed and consumed.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].name-id-policy-allow-create=TRUE

    • Flag to indicate whether the allow-create flags for nameid policies should be set to true, false or ignored/defined.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].name-id-policy-format=

    • NameID policy to request in the authentication requests.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].partial-logout-as-success=true

    • Logouts are only successful if the IdP was able to inform all services, otherwise it will respond with PartialLogout. This setting allows clients such as CAS to ignore such server-side behavior. If the IdP reports back a partial logout, this setting instructs CAS whether it should accept or deny that response.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].passive=

    • Whether authentication requests should be tagged as passive.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].principal-id-attribute=

    • The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].provider-name=

    • Provider name set for the saml authentication request. Sets the human-readable name of the requester for use by the presenter's user agent or the identity provider.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].request-initiator-url=

    • When generating SAML2 metadata, configure and set the request initiator location attribute.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].requested-attributes.friendly-name=

    • Attribute friendly name.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderRequestedAttribute.
  • cas.authn.pac4j.saml[0].requested-attributes.name=

    • Attribute name.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderRequestedAttribute.
  • cas.authn.pac4j.saml[0].requested-attributes.name-format=urn:oasis:names:tc:SAML:2.0:attrname-format:uri

    • Attribute name format.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderRequestedAttribute.
  • cas.authn.pac4j.saml[0].requested-attributes.required=

    • Whether this attribute is required and should be marked so in the metadata.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderRequestedAttribute.
  • cas.authn.pac4j.saml[0].response-binding-type=

    • The SAML2 response binding type to use when generating metadata. This ultimately controls the binding type of the assertion consumer service in the metadata. Default value is typically urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].response-destination-mandatory=true

    • When validating the response, ensure it has a value set for the Destination attribute.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].saml2-attribute-converter=

    • Controls the way SAML2 attributes are converted from the authentication response into pac4j attributes. By default, values of complex types are serialized into a single attribute. To change this behaviour, a converter class implementing the { AttributeConverter interface.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].sign-authn-request=

    • Whether or not the authnRequest should be signed.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].sign-service-provider-logout-request=

    • Whether or not the Logout Request sent from the SP should be signed.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].sign-service-provider-metadata=

    • Whether or not SAML SP metadata should be signed when generated.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].signature-algorithms=

    • Collection of signing signature algorithms, if any, to override the global defaults.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].signature-canonicalization-algorithm=

    • The signing signature canonicalization algorithm, if any, to override the global defaults.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].signature-reference-digest-methods=

    • Collection of signing signature reference digest methods, if any, to override the global defaults.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].single-logout-service-url=

    • When generating SAML2 metadata, configure and set the single logout service URL attribute.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].supported-protocols=urn:oasis:names:tc:SAML:2.0:protocol

    • When generating SAML2 metadata, configure and set the list of supported protocols in the metadata.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].use-name-qualifier=true

    • Whether name qualifiers should be produced in the final saml response.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].wants-assertions-signed=

    • Whether metadata should be marked to request sign assertions.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.
  • cas.authn.pac4j.saml[0].wants-responses-signed=

    • Whether a response has to be mandatory signed.

    org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientProperties.

    Configuration Metadata

    The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

    Be Selective

    This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

    YAGNI

    Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

    Naming Convention

    Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

    :information_source: Note

    When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

    Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

    Validation

    Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

    Indexed Settings

    CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

    Metadata Management

    SAML2 metadata for both the delegated identity provider as well as the (CAS) service provider can managed via the following settings.

    • The following settings and properties are available from the CAS configuration catalog:

      The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

    • cas.authn.pac4j.saml[0].metadata.identity-provider-metadata-path=

      • The metadata location of the identity provider that is to handle authentications. The location can be specified as a direct absolute path to the metadata file or it may also be a URL to the identity provider's metadata endpoint.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlClientMetadataProperties.
      The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

      Configuration Metadata

      The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

      Be Selective

      This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

      YAGNI

      Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

      Naming Convention

      Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

      :information_source: Note

      When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

      Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

      Validation

      Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

      Indexed Settings

      CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

    • Default

      SAML2 metadata for CAS as the SAML2 service provider is typically managed on disk, and generated on startup if the metadata file is not found. Future and subsequent changes to this metadata file, if necessary, must be handled manually and the file might need to be curated and edited to fit your purposes.

      The following settings and properties are available from the CAS configuration catalog:

      The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

    • cas.authn.pac4j.saml[0].metadata.service-provider.file-system.location=/tmp/samlSpMetadata11210290670339019932.xml

      • Location of the SP metadata to use and generate on the file system. If the metadata file already exists, it will be ignored and reused. Location of the SP metadata to use and generate on the file system. If the metadata file already exists, it will be ignored and reused.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataFileSystemProperties.
      The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

      Configuration Metadata

      The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

      Be Selective

      This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

      YAGNI

      Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

      Naming Convention

      Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

      :information_source: Note

      When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

      Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

      Validation

      Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

      Indexed Settings

      CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

      MongoDb

      SAML2 metadata for CAS as the SAML2 service provider may also be managed inside a MongoDb instance. To active this feature, you need to start by including the following module in the overlay:

      

      1
2
3
4
5

      		

      <dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-mongo-core</artifactId>
    <version>${cas.version}</version>
</dependency>

      		

      

      1

      		

      implementation "org.apereo.cas:cas-server-support-mongo-core:${project.'cas.version'}"

      		

      

      1
2
3
4
5
6
7
8
9

      		

      dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-mongo-core"
}

      		

      

      1
2
3
4
5
6

      		

      dependencies {
    implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
    implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)

    implementation "org.apereo.cas:cas-server-support-mongo-core"
}

      Next, you should activate and turn on the feature:

      Feature Activation

      To activate this feature, the following feature toggle(s) must be turned on:

      

      1

      		

      CasFeatureModule.DelegatedAuthentication.saml-mongodb.enabled=true

      To learn more about configuration feature toggles, please see this page.

      Finally, please make sure you have specified a collection name in your CAS settings that would ultimately house the generated SAML2 metadata.

      The following settings and properties are available from the CAS configuration catalog:

      The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.client-uri=

      • The connection uri to the mongodb instance. This typically takes on the form of mongodb://user:psw@ds135522.somewhere.com:35522/db. If not specified, will fallback onto other individual settings. If specified, takes over all other settings where applicable.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.collection=

      • MongoDb database collection name to fetch and/or create.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.database-name=

      • MongoDb database instance name.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.host=

      • MongoDb database host for authentication. Multiple host addresses may be defined, separated by comma. If more than one host is defined, it is assumed that each host contains the port as well, if any. Otherwise the configuration may fallback onto the port defined.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.password=

      • MongoDb database password for authentication.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.port=

      • MongoDb database port.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.user-id=

      • MongoDb database user for authentication.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
      The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.authentication-database-name=

      • Name of the database to use for authentication.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.drop-collection=

      • Whether collections should be dropped on startup and re-created.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.pool.idle-time=PT30S

      • The maximum idle time of a pooled connection. A zero value indicates no limit to the idle time. A pooled connection that has exceeded its idle time will be closed and replaced when necessary by a new connection.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.pool.life-time=PT60S

      • The maximum time a pooled connection can live for. A zero value indicates no limit to the life time. A pooled connection that has exceeded its life time will be closed and replaced when necessary by a new connection.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.pool.max-size=10

      • Maximum number of connections to keep around.

      org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.pool.max-wait-time=PT60S

      • The maximum time that a thread may wait for a connection to become available.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.pool.min-size=1

      • Minimum number of connections to keep around.

      org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.pool.per-host=10

      • Total number of connections allowed per host.

      org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.read-concern=

      • Read concern. Accepted values are:

      • LOCAL
      • MAJORITY
      • LINEARIZABLE
      • SNAPSHOT
      • AVAILABLE

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.read-preference=

      • Read preference. Accepted values are:

      • PRIMARY
      • SECONDARY
      • SECONDARY_PREFERRED
      • PRIMARY_PREFERRED
      • NEAREST

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.replica-set=

      • A replica set in MongoDB is a group of mongod processes that maintain the same data set. Replica sets provide redundancy and high availability, and are the basis for all production deployments.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.retry-writes=

      • Sets whether writes should be retried if they fail due to a network error.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.socket-keep-alive=

      • Whether the database socket connection should be tagged with keep-alive.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.ssl-enabled=

      • Whether connections require SSL.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.timeout=

      • MongoDb database connection timeout.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.mongo.write-concern=

      • Write concern describes the level of acknowledgement requested from MongoDB for write operations to a standalone mongo db or to replica sets or to sharded clusters. In sharded clusters, mongo db instances will pass the write concern on to the shards.

      org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties.

      Configuration Metadata

      The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

      Be Selective

      This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

      YAGNI

      Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

      Naming Convention

      Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

      :information_source: Note

      When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

      Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

      Validation

      Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

      Indexed Settings

      CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

      JDBC

      SAML2 metadata for CAS as the SAML2 service provider may also be managed inside a relational database instance. To active this feature, you need to start by including the following module in the overlay:

      

      1
2
3
4
5

      		

      <dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-jpa-util</artifactId>
    <version>${cas.version}</version>
</dependency>

      		

      

      1

      		

      implementation "org.apereo.cas:cas-server-support-jpa-util:${project.'cas.version'}"

      		

      

      1
2
3
4
5
6
7
8
9

      		

      dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-jpa-util"
}

      		

      

      1
2
3
4
5
6

      		

      dependencies {
    implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
    implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)

    implementation "org.apereo.cas:cas-server-support-jpa-util"
}

      Next, you should activate and turn on the feature:

      Feature Activation

      To activate this feature, the following feature toggle(s) must be turned on:

      

      1

      		

      CasFeatureModule.DelegatedAuthentication.saml-jdbc.enabled=true

      To learn more about configuration feature toggles, please see this page.

      Finally, please make sure you have specified a table name in your CAS settings that would ultimately house the generated SAML2 metadata.

      The following settings and properties are available from the CAS configuration catalog:

      The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.driver-class=

      • The JDBC driver used to connect to the database.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.password=

      • The database connection password.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.table-name=

      • The table name in the database that holds the SAML2 service provider metadata. The table structure and columns must be created and exist beforehand, and must match the following SQL statements, with expected adjustments depending on database type, driver and dialect:

      CREATE TABLE sp_metadata (entityId VARCHAR(512), metadata TEXT)

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.url=

      • The database connection URL.

      This setting supports the Spring Expression Language.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.user=

      • The database user.

      The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
      The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.keep-alive-time=0

      • This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.max-size=18

      • Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.max-wait=PT2S

      • Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

      A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.maximum-lifetime=PT10M

      • This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.min-size=6

      • Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.name=d9faa8ea-54c3-4d89-9f69-e0e29b75b469

      • Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.suspension=

      • Whether or not pool suspension is allowed.

      There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it.

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.pool.timeout-millis=1000

      • The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

      org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.autocommit=

      • The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.batch-size=

      • A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.data-source-name=

      • Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.ddl-auto=

      • Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to validate or none may be more desirable for production, but any of the following options can be used:

      • validate: Validate the schema, but make no changes to the database.
      • update: Update the schema.
      • create: Create the schema, destroying previous data.
      • create-drop: Drop the schema at the end of the session.
      • none: Do nothing.

      Note that during a version migration where any schema has changed create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use.

      For more info, see this.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.default-catalog=

      • Qualifies unqualified table names with the given catalog in generated SQL.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.default-schema=

      • Qualify unqualified table names with the given schema/tablespace in generated SQL.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.dialect=

      • The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.fail-fast-timeout=

      • Set the pool initialization failure timeout.

      • Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a PoolInitializationException will be thrown.
      • A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the connectionTestQuery and connectionInitSql are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the the pool will start and continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
      • A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
      Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.fetch-size=

      • Used to specify number of rows to be fetched in a select query.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.generate-statistics=

      • Allow hibernate to generate query statistics.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.health-query=

      • The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.idle-timeout=

      • Controls the maximum amount of time that a connection is allowed to sit idle in the pool.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.isolate-internal-queries=

      • This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.

      Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if #autocommit is disabled.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.isolation-level-name=

      • Defines the isolation level for transactions.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.leak-threshold=

      • Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.

      This settings supports the java.time.Duration syntax [?].

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.physical-naming-strategy-class-name=

      • Fully-qualified name of the class that can control the physical naming strategy of hibernate.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.propagation-behavior-name=

      • Defines the propagation behavior for transactions.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.properties=

      • Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.
    • cas.authn.pac4j.saml[0].metadata.service-provider.jdbc.read-only=

      • Configures the Connections to be added to the pool as read-only Connections.

      org.apereo.cas.configuration.model.support.pac4j.saml.Pac4jSamlServiceProviderMetadataJdbcProperties.

      Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.
    • cas.jdbc.case-insensitive=false

      • When choosing physical table names, determine whether names should be considered case-insensitive.

    • cas.jdbc.gen-ddl=true

      • Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.

    • cas.jdbc.physical-table-names=

      • Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default.

    • cas.jdbc.show-sql=false

      • Whether SQL queries should be displayed in the console/logs.

      Configuration Metadata

      The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

      Be Selective

      This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

      YAGNI

      Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

      Naming Convention

      Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

      :information_source: Note

      When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

      Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

      Validation

      Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

      Indexed Settings

      CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

      The table structure and schema needs to be created and must exist prior to CAS starting up, and it should be modeled after the following SQL statement:

      

      1

      		

      CREATE TABLE <table-name> (entityId VARCHAR(512), metadata TEXT)

    Per Service Customizations

    Th configuration for the external SAML2 identity provider is typically done at build time via CAS configuration settings and applies to all applications and relying parties. You may override certain aspects this configuration on a per application basis by assigning dedicated properties to the service definition.

    The following properties are available and recognized by CAS for various modules and features:

    Name Default Value Type Group
    forceAuthn BOOLEAN DELEGATED_AUTHN
    passiveAuthn BOOLEAN DELEGATED_AUTHN
    AuthnRequestBindingType STRING DELEGATED_AUTHN_SAML2
    AssertionConsumerServiceIndex LONG DELEGATED_AUTHN_SAML2
    AttributeConsumingServiceIndex LONG DELEGATED_AUTHN_SAML2
    ComparisonType STRING DELEGATED_AUTHN_SAML2
    NameIdPolicyFormat STRING DELEGATED_AUTHN_SAML2
    NameIdPolicyAllowCreate BOOLEAN DELEGATED_AUTHN_SAML2
    ProviderName STRING DELEGATED_AUTHN_SAML2
    IssuerFormat STRING DELEGATED_AUTHN_SAML2
    UseNameQualifier BOOLEAN DELEGATED_AUTHN_SAML2
    AuthnContextClassRefs SET DELEGATED_AUTHN_SAML2
    NameIdAttribute STRING DELEGATED_AUTHN_SAML2
    WantsAssertionsSigned BOOLEAN DELEGATED_AUTHN_SAML2
    WantsResponsesSigned BOOLEAN DELEGATED_AUTHN_SAML2
    MaximumAuthenticationLifetime LONG DELEGATED_AUTHN_SAML2

    A sample JSON file follows:

    

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

    		

    {
  "@class" : "org.apereo.cas.services.CasRegisteredService",
  "serviceId" : "^https://app.example.org",
  "name" : "Example",
  "id" : 1,
  "properties" : {
    "@class" : "java.util.HashMap",
    "AuthnContextClassRefs" : {
      "@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
      "values" : [ "java.util.HashSet", [ "https://refeds.org/profile/mfa" ] ]
    },
    "WantsAssertionsSigned" : {
      "@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
      "values" : [ "java.util.HashSet", [ "false" ] ]
    }
  }
}

    See registered service properties for more details.

    Troubleshooting

    To enable additional logging, modify the logging configuration file to add the following:

    

    1
2
3
4
5
6
7
8
9

    		

    <Logger name="org.opensaml" level="debug" additivity="false">
    <AppenderRef ref="console"/>
    <AppenderRef ref="file"/>
</Logger>

<Logger name="PROTOCOL_MESSAGE" level="debug" additivity="false">
    <AppenderRef ref="console"/>
    <AppenderRef ref="file"/>
</Logger>

    Identity Provider Discovery Service

    :information_source: Note

    Using identity provider discovery requires delegated authentication to be available. This feature cannot be used on its own as a standalone discovery service.

    

    1
2
3
4
5

    		

    <dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-saml-idp-discovery</artifactId>
    <version>${cas.version}</version>
</dependency>

    		

    

    1

    		

    implementation "org.apereo.cas:cas-server-support-saml-idp-discovery:${project.'cas.version'}"

    		

    

    1
2
3
4
5
6
7
8
9

    		

    dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-saml-idp-discovery"
}

    		

    

    1
2
3
4
5
6

    		

    dependencies {
    implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
    implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)

    implementation "org.apereo.cas:cas-server-support-saml-idp-discovery"
}

    Identity provider discovery allows CAS to embed and present a discovery service as part of delegated authentication. Configured SAML2 identity providers in the CAS configuration used for delegated authentication are presented as options for discovery.

    CAS is also able to directly consume multiple JSON feeds that contain discovery metadata about available identity providers. The discovery JSON feed may be fetched from a URL (i.e. exposed by a Shibboleth Service Provider) or it may directly be consumed as a JSON file with the following structure:

    

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

    		

    [{
 "entityID": "https://idp.example.net/idp/saml",
 "DisplayNames": [{
  "value": "Example.net",
  "lang": "en"
  }],
 "Descriptions": [{
  "value": "An identity provider for the people, by the people.",
  "lang": "en"
  }],
 "Logos": [{
  "value": "https://example.net/images/logo.png",
  "height": "90",
  "width": "62"
  }]
}]

    The following endpoints are available:

    Endpoint Description
    /idp/discovery Identity provider discovery landing page.
    /idp/discovery/feed Identity provider discovery JSON feed.
    /idp/discovery/redirect Return endpoint to let CAS invoke the identity provider after selection.

    Applications may directly invoke the discovery service via [cas-server-prefix]/idp/discovery. The discovery service may also be invoked using the discovery protocol via [cas-server-prefix]/idp/discovery?entityID=[service-provider-entity-id]&return=[cas-server-prefix]/idp/discovery/redirect. Additional parameters may be included as part of the return url and they all must be encoded.